Aurora Partner Web Service
API Enhancement Summary
API Enhancement Summary – Mule API Version 2
Release Version: 2.0
Change Type: Enhancement
Status: Implemented
Enhancements in Mule API Version 2.0 for Partners
The following enhancements have been introduced in Mule API Version 2.0 to provide more granular detail in pricing calculations and robust support for internationalization. These changes primarily affect the response payload and the API URL structure.
💰 Pricing Calculation Fields (Response Payload)
Three new fields have been added to the API's response payload to provide a clearer breakdown of the pricing before and after promotions:
- Gross Price (grossPrice)
Description: This field represents the total base price of the item before the application of any promotions or discounts.
- Net Price (netPrice)
Description: This field represents the final price after applying the primary percentage-based promotion and the flat-value additional promotion.
Calculation Formula: The netPrice is calculated using the following formula:$NetPrice = GrossPrice \times \left(\frac{100 + PromotionValue}{100}\right) + AdditionalPromotion$
GrossPrice: The base price before discounts.
PromotionValue: The percentage value of the primary promotion/discount.
AdditionalPromotion: The flat-value promotion applied on top of the calculated discounted price.
- Additional Promotion Price (additionalPromotion)
Description: This field represents a flat promotional discount value that is applied on top of the price already discounted by the percentage-based promotion (the value used in the Net Price calculation).
🌐 Internationalization Support (URL Parameter)New Query Parameter:
currencyDescription: A new query parameter named currency has been introduced to the API URL. This allows the calling application (the partner) to specify the desired currency for the returned pricing fields.
Usage: Partners must include this parameter in the API request URL to receive localized pricing.
Supported Currency
- AUD
- USD
- GBP
- CAD
- NZD
- EUR
Example usage: api/service?voyage=SVD004S¤cy=USD
The API will return prices formatted according to the requested currency, supporting international pricing.